package be.jaisy.ui.gwt.client.widget;


import com.google.gwt.user.client.ui.Composite;

/**
 * A 'sink' is a single panel of the kitchen sink. They are meant to be lazily
 * instantiated so that the application doesn't pay for all of them on startup.
 */
public abstract class Sink extends Composite {

  /**
   * Encapsulated information about a sink. Each sink is expected to have a
   * static <code>init()</code> method that will be called by the entry point sink
   * on startup.
   */
  public abstract static class SinkInfo {
    private Sink instance;
    private String name, description;
    private ActionsBar actionsBar;
    private String color = "#2a8ebf";

    public SinkInfo(String name, String desc) {
      this.name = name;
      description = desc;
    }

    public SinkInfo(String name, String desc, String color, ActionsBar actionsBar) {
        this.name = name;
        this.description = desc;
    	this.color = color;
        this.actionsBar = actionsBar;
      }
    
    public abstract Sink createInstance();

    public String getColor() {
      return this.color;
    }

    public String getDescription() {
      return description;
    }

    public ActionsBar getActionsBar() {
		return actionsBar;
	}

	public final Sink getInstance() {
      if (instance != null) {
        return instance;
      }
      return (instance = createInstance());
    }

    public String getName() {
      return name;
    }
  }

  /**
   * Called just before this sink is hidden.
   */
  public void onHide() {
  }

  /**
   * Called just after this sink is shown.
   */
  public void onShow() {
  }
}
